Fix and Edit build time OpenAPI/ra/b #33361
Conversation
Rick-Anderson
left a comment
Rick-Anderson
left a comment
There was a problem hiding this comment.
@captainsafia this is just a quick edit. It likely has lots of error I'll find tomorrow. I do have a couple questions. Note this branch fixes all the build errors in your branch. This will merge into your branch so you should get credit for the commit to main.
| if (Assembly.GetEntryAssembly()?.GetName().Name != "GetDocument.Insider") | ||
| { | ||
| // builder.Services.AddDefaults(); | ||
| } |
There was a problem hiding this comment.
builder.Services.AddDefaults(); generates the error:
'IServiceCollection' does not contain a definition for 'AddDefaults'
There was a problem hiding this comment.
This is my bad...I had trouble figuring out what would be a good illustration of a setup here.
Maybe we can do something that configures an EF Core DB context?
services.AddDbContext<MyContext>(options =>
options.UseSqlServer(Configuration.GetConnectionString("DefaultConnection")));
We'd have to add a definition for MyContext and the package references for EF
There was a problem hiding this comment.
This is my bad...I had trouble figuring out what would be a good illustration of a setup here.
Maybe we can do something that configures an EF Core DB context?
services.AddDbContext<MyContext>(options => options.UseSqlServer(Configuration.GetConnectionString("DefaultConnection")));We'd have to add a definition for
MyContextand the package references for EF
I have:
| //if (Assembly.GetEntryAssembly()?.GetName().Name != "GetDocument.Insider") | ||
| //{ | ||
| builder.Services.AddDbContext<ControllerApiContext>(options => | ||
| options.UseSqlServer(builder.Configuration.GetConnectionString("ControllerApiContext") | ||
| ?? throw new InvalidOperationException("Connection string 'ControllerApiContext' not found."))); | ||
| //} |
There was a problem hiding this comment.
I don't see any connection string or sql info when //if (Assembly.GetEntryAssembly()?.GetName().Name != "GetDocument.Insider") is commented out. I don't see any difference in the generated OpenAPI file with or without the build check.
There was a problem hiding this comment.
I don't see any connection string or sql info when //if (Assembly.GetEntryAssembly()?.GetName().Name != "GetDocument.Insider") is commented out
I believe this is because there isn't a connection string configured in the appsettings for this project. See changes in c86bab7.
I don't see any difference in the generated OpenAPI file with or without the build check.
In this case, that is the expected behavior. 👍🏽
Rick-Anderson
changed the title
|
@captainsafia can you look this over and let me know what needs to change/delete before I can S&M it into your #33359? I'll then fix the merge conflicts in your #33359. |
mikekistler
left a comment
mikekistler
left a comment
There was a problem hiding this comment.
This looks good, but I want to suggest an alternative organization:
- Broadening the "Generating OpenAPI documents at build time" to cover all of the "Generating OpenAPI documents" content. That would involve pulling the first two sections of the "Work with OpenAPI documents" (Package Installation and Configuring OpenAPI Generation) over into this doc, leaving the "Work with" doc more clearly focused on how to add metadata. If we did this I think the Generating OpenAPI documents topic would then come before "Working with ...".
Up to you if you think that's a better approach. I'll approve now since I think all the content here is solid.
Co-authored-by: Mike Kistler <[email protected]>
captainsafia
left a comment
captainsafia
left a comment
There was a problem hiding this comment.
Let's merge this and continue iterating on the other PR -- I think this is in good enough shape.
Branch of #33359
Merges into #33359
Fixes #33391
Internal previews